docs: update rtd to use sphinxcontrib-bibtex v2.0.0 and later #1019
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- new entry in conf.py for the bibtex config - had to remove the keyprefix from references
|
@bjonkman, this should fix the python version issue you ran into with the documentation builds. |
|
Thanks, @andrew-platt! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is ready to merge.
Summary
I had locked the
sphinxcontrib-bibtexversion to < 2.0.0 when I ran into issues with multiple bibliographies that we use (one per module). This was increasingly becoming a problem as python 3.8 and later would like to use a newer version.Solution
The
conf.pywas updated to include abibtex_bibfilesvariable. However, the new version ofsphinxcontrib-bibtexis more thorough in checking for repeated bibtex entries, and complained about a few duplicated entries (checked across all bib files). This required hardcoding of thekeyprefixvalues into each modules .bib file instead of using sphinx to insert them. The rendering is therefore identical to the previous behavior, but will now compile correctly with the newer package.See https://ap-openfast.readthedocs.io/en/f-docs-bibtex2.0.0/source/user/fast.farm/zrefs.html (duplicated entries first appeared in the fast.farm docs).